/**
 *
 *  Copyright (c) 2011, AstroDAbis
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without modification,
 *  are permitted provided that the following conditions are met:
 *
 *      * Redistributions of source code must retain the above copyright notice,
 *        this list of conditions and the following disclaimer.
 *      * Redistributions in binary form must reproduce the above copyright notice,
 *        this list of conditions and the following disclaimer in the documentation
 *        and/or other materials provided with the distribution.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 *  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 *  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 *  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 *  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 *  OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
package org.jiscinvolve.astrodabis.mallow.util;

import java.util.Iterator;
import java.lang.Iterable;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * Iterable wrapper to handle generic typecasts.
 *
 */
public class GenericIterable<I, T extends I>
implements Iterable<I>
    {

    /**
     * Our debug logger.
     * 
     */
    private static Log log = LogFactory.getLog(GenericIterable.class);

    /**
     * Public constructor.
     *
     */
    public GenericIterable(Iterable<T> iterable)
        {
        log.debug("GenericIterable(Iterable<T>)");
        log.debug("  Class [" + iterable.getClass().getName() + "]");
        this.iterable = iterable ;
        }

    /**
     * Our source iterable collection.
     *
     */
    private Iterable<T> iterable ;

    /**
     * Inner class to implement the Iterator interface.
     *
     */
    private class GenericIterator
        implements Iterator<I>
        {

        /**
         * Private constructor.
         *
         */
        private GenericIterator(Iterator<T> iterator)
            {
            this.iterator = iterator ;
            }

        /**
         * Our source iterator.
         *
         */
        private Iterator<T> iterator ;

        @Override
        public boolean hasNext()
            {
            return iterator.hasNext();
            }

        @Override
        public I next()
            {
            return iterator.next();
            }

        @Override
        public void remove()
            {
            iterator.remove();
            }
        }

    @Override
    public Iterator<I> iterator()
        {
        return new GenericIterator(
            this.iterable.iterator()
            );
        }

    /**
     * Bean style method to support JSTL forEach.
     * http://stackoverflow.com/questions/2978536/jstl-using-foreach-to-iterate-over-a-user-defined-class
     * http://stackoverflow.com/questions/6212622/how-can-i-work-with-iterables-in-my-jsp-pages
     *
     */
    public Iterator<I> getIter()
        {
        return iterator();
        }

    }

